<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>Global - Documentation</title>

    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>

<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
  <div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav>
    <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Editor.html">Editor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#clear">clear</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#close">close</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#convert">convert</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#export_">export_</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#forceChange">forceChange</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#getSupportedImportMimeTypes">getSupportedImportMimeTypes</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#import_">import_</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#pointerDown">pointerDown</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#pointerEvents">pointerEvents</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#pointerMove">pointerMove</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#pointerUp">pointerUp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#redo">redo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#reDraw">reDraw</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#resize">resize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#setGuides">setGuides</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#undo">undo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#unload">unload</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Editor.html#waitForIdle">waitForIdle</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#addListeners">addListeners</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#addPoint">addPoint</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#addStroke">addStroke</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#addStrokes">addStrokes</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#addStrokeToGroup">addStrokeToGroup</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#addWebsocketAttributes">addWebsocketAttributes</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#appendToPendingStroke">appendToPendingStroke</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#attach">attach</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#buildHmacMessage">buildHmacMessage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#buildWebSocketCallback">buildWebSocketCallback</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#callFadeOutObserver">callFadeOutObserver</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#canReconnect">canReconnect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#clear">clear</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#clearModel">clearModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#clickCandidate">clickCandidate</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#cloneModel">cloneModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#close">close</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CLOSE_RECOGNIZER_MESSAGE">CLOSE_RECOGNIZER_MESSAGE</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#computeAxeAngle">computeAxeAngle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#computeHmac">computeHmac</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#computeLinksPoints">computeLinksPoints</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#computeMiddlePoint">computeMiddlePoint</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#convert">convert</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createEmptyRecognizerContext">createEmptyRecognizerContext</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createHTMLElements">createHTMLElements</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createModel">createModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createSmartGuide">createSmartGuide</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createStrokeComponent">createStrokeComponent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createUndoRedoContext">createUndoRedoContext</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#defaultBehaviors">defaultBehaviors</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#defaultConfiguration">defaultConfiguration</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#defaultPenStyle">defaultPenStyle</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#defaultTheme">defaultTheme</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#delay">delay</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#destructurePromise">destructurePromise</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#detach">detach</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#drawCurrentStroke">drawCurrentStroke</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#drawLine">drawLine</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#drawMathSymbol">drawMathSymbol</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#drawModel">drawModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#drawShapeSymbol">drawShapeSymbol</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#drawStroke">drawStroke</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#drawTextSymbol">drawTextSymbol</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#editorLogger">editorLogger</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#emitEvents">emitEvents</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#endPendingStroke">endPendingStroke</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#eventLogger">eventLogger</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#export_">export_</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#extractPendingRecognizedSymbols">extractPendingRecognizedSymbols</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#extractPendingStrokes">extractPendingStrokes</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#extractStrokesFromInkRange">extractStrokesFromInkRange</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getAvailableLanguageList">getAvailableLanguageList</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getBorderCoordinates">getBorderCoordinates</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getImage">getImage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getInfo">getInfo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getModel">getModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getPointByIndex">getPointByIndex</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getSupportedImportMimeTypes">getSupportedImportMimeTypes</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getSymbolsBounds">getSymbolsBounds</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#grabberLogger">grabberLogger</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#handleError">handleError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#handleSuccess">handleSuccess</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#iinkRestConfiguration">iinkRestConfiguration</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#IinkWsConfiguration">IinkWsConfiguration</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#import_">import_</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#init">init</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#initPendingStroke">initPendingStroke</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#inkImporter">inkImporter</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#insertSmartGuide">insertSmartGuide</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isInShadow">isInShadow</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isResetRequired">isResetRequired</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isTriggerValid">isTriggerValid</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#launchClose">launchClose</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#launchConfig">launchConfig</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#launchConvert">launchConvert</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#launchExport">launchExport</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#launchGetSupportedImportMimeTypes">launchGetSupportedImportMimeTypes</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#launchImport">launchImport</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#launchPointerEvents">launchPointerEvents</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#launchResize">launchResize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#launchSmartGuide">launchSmartGuide</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#launchWaitForIdle">launchWaitForIdle</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#log">log</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#LOST_CONNEXION_MESSAGE">LOST_CONNEXION_MESSAGE</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#manageRecognizedModel">manageRecognizedModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#manageResetState">manageResetState</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#MathSymbols">MathSymbols</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#mergeModels">mergeModels</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#modelLogger">modelLogger</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#needRedraw">needRedraw</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#newContentPart">newContentPart</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#openContentPart">openContentPart</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#openWebSocket">openWebSocket</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#overrideDefaultBehaviors">overrideDefaultBehaviors</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#overrideDefaultConfiguration">overrideDefaultConfiguration</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#overrideDefaultPenStyle">overrideDefaultPenStyle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#overrideDefaultTheme">overrideDefaultTheme</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#post">post</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#postMessage">postMessage</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#recognizerLogger">recognizerLogger</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#redo">redo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#register">register</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#rendererLogger">rendererLogger</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#reset">reset</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#resetModelPositions">resetModelPositions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#resetModelRendererPosition">resetModelRendererPosition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#resize">resize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#send">send</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#sendConfiguration">sendConfiguration</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#sendMessage">sendMessage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#setPenStyle">setPenStyle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#setPenStyleClasses">setPenStyleClasses</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#setRecognitionContext">setRecognitionContext</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#setTheme">setTheme</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#ShapeSymbols">ShapeSymbols</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#shouldAttemptImmediateReconnect">shouldAttemptImmediateReconnect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#showActions">showActions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#showCandidates">showCandidates</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#slice">slice</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#smartGuideLogger">smartGuideLogger</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#testLogger">testLogger</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#TextSymbols">TextSymbols</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#toJSON">toJSON</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#undo">undo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#updateModel">updateModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#updateModelReceivedPosition">updateModelReceivedPosition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#updateModelRenderedPosition">updateModelRenderedPosition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#updateModelSentPosition">updateModelSentPosition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#updateRecognitionPositions">updateRecognitionPositions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#updateUndoRedoState">updateUndoRedoState</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#utilLogger">utilLogger</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#waitForIdle">waitForIdle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#zoom">zoom</a></span></li>
</nav>

<div id="main">
    
    <h1 class="page-title">Global</h1>
    

    




<section>

<header>
    
        <h2>
        
        </h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        

        


<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>


        
    
    </div>

    

    

    

     

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<div class="section-members">
<h4 class="name" id="CLOSE_RECOGNIZER_MESSAGE"><span class="type-signature">(constant) </span>CLOSE_RECOGNIZER_MESSAGE<span class="type-signature"> :String</span></h4>




<div class="description">
    Explicit close message
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_RecognizerContext.js.html">model/RecognizerContext.js</a>, <a href="model_RecognizerContext.js.html#line145">line 145</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>String</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="defaultBehaviors"><span class="type-signature">(constant) </span>defaultBehaviors<span class="type-signature"> :<a href="global.html#Behaviors">Behaviors</a></span></h4>




<div class="description">
    Default behaviors
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultBehaviors.js.html">configuration/DefaultBehaviors.js</a>, <a href="configuration_DefaultBehaviors.js.html#line36">line 36</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code><a href="global.html#Behaviors">Behaviors</a></code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="defaultConfiguration"><span class="type-signature">(constant) </span>defaultConfiguration<span class="type-signature"></span></h4>




<div class="description">
    Default configuration
See https://developer.myscript.com/docs/interactive-ink/latest/reference/web/configuration/ for a full documentation of parameters.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultConfiguration.js.html">configuration/DefaultConfiguration.js</a>, <a href="configuration_DefaultConfiguration.js.html#line8">line 8</a>
    </li></ul></dd>
    

    

    

    
</dl>







</div>

        
            
<div class="section-members">
<h4 class="name" id="defaultPenStyle"><span class="type-signature">(constant) </span>defaultPenStyle<span class="type-signature"> :<a href="global.html#PenStyle">PenStyle</a></span></h4>




<div class="description">
    Default style
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultPenStyle.js.html">configuration/DefaultPenStyle.js</a>, <a href="configuration_DefaultPenStyle.js.html#line17">line 17</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code><a href="global.html#PenStyle">PenStyle</a></code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="defaultTheme"><span class="type-signature">(constant) </span>defaultTheme<span class="type-signature"> :<a href="global.html#Theme">Theme</a></span></h4>




<div class="description">
    Default theme
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultTheme.js.html">configuration/DefaultTheme.js</a>, <a href="configuration_DefaultTheme.js.html#line34">line 34</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code><a href="global.html#Theme">Theme</a></code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="editorLogger"><span class="type-signature">(constant) </span>editorLogger<span class="type-signature"> :Object</span></h4>




<div class="description">
    Log editor events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_LoggerConfig.js.html">configuration/LoggerConfig.js</a>, <a href="configuration_LoggerConfig.js.html#line15">line 15</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="eventLogger"><span class="type-signature">(constant) </span>eventLogger<span class="type-signature"> :Object</span></h4>




<div class="description">
    Log callback events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_LoggerConfig.js.html">configuration/LoggerConfig.js</a>, <a href="configuration_LoggerConfig.js.html#line57">line 57</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="grabberLogger"><span class="type-signature">(constant) </span>grabberLogger<span class="type-signature"> :Object</span></h4>




<div class="description">
    Log grabber events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_LoggerConfig.js.html">configuration/LoggerConfig.js</a>, <a href="configuration_LoggerConfig.js.html#line36">line 36</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="iinkRestConfiguration"><span class="type-signature">(constant) </span>iinkRestConfiguration<span class="type-signature"> :<a href="global.html#RecognizerInfo">RecognizerInfo</a></span></h4>




<div class="description">
    Recognizer configuration
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_rest_iinkRestRecognizer.js.html">recognizer/rest/iinkRestRecognizer.js</a>, <a href="recognizer_rest_iinkRestRecognizer.js.html#line18">line 18</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code><a href="global.html#RecognizerInfo">RecognizerInfo</a></code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="IinkWsConfiguration"><span class="type-signature">(constant) </span>IinkWsConfiguration<span class="type-signature"> :<a href="global.html#RecognizerInfo">RecognizerInfo</a></span></h4>




<div class="description">
    Recognizer configuration
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line40">line 40</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code><a href="global.html#RecognizerInfo">RecognizerInfo</a></code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="log"><span class="type-signature">(constant) </span>log<span class="type-signature"> :Object</span></h4>




<div class="description">
    Main log instance
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_LoggerConfig.js.html">configuration/LoggerConfig.js</a>, <a href="configuration_LoggerConfig.js.html#line8">line 8</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="LOST_CONNEXION_MESSAGE"><span class="type-signature">(constant) </span>LOST_CONNEXION_MESSAGE<span class="type-signature"> :Object</span></h4>




<div class="description">
    Lost connection message
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_RecognizerContext.js.html">model/RecognizerContext.js</a>, <a href="model_RecognizerContext.js.html#line139">line 139</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="MathSymbols"><span class="type-signature">(constant) </span>MathSymbols<span class="type-signature"> :Object</span></h4>








<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_symbols_MathSymbolCanvasRenderer.js.html">renderer/canvas/symbols/MathSymbolCanvasRenderer.js</a>, <a href="renderer_canvas_symbols_MathSymbolCanvasRenderer.js.html#line8">line 8</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="modelLogger"><span class="type-signature">(constant) </span>modelLogger<span class="type-signature"> :Object</span></h4>




<div class="description">
    Log model events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_LoggerConfig.js.html">configuration/LoggerConfig.js</a>, <a href="configuration_LoggerConfig.js.html#line29">line 29</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="recognizerLogger"><span class="type-signature">(constant) </span>recognizerLogger<span class="type-signature"> :Object</span></h4>




<div class="description">
    Log recognizer events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_LoggerConfig.js.html">configuration/LoggerConfig.js</a>, <a href="configuration_LoggerConfig.js.html#line50">line 50</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="rendererLogger"><span class="type-signature">(constant) </span>rendererLogger<span class="type-signature"> :Object</span></h4>




<div class="description">
    Log grabber events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_LoggerConfig.js.html">configuration/LoggerConfig.js</a>, <a href="configuration_LoggerConfig.js.html#line43">line 43</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="ShapeSymbols"><span class="type-signature">(constant) </span>ShapeSymbols<span class="type-signature"> :Object</span></h4>








<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_symbols_ShapeSymbolCanvasRenderer.js.html">renderer/canvas/symbols/ShapeSymbolCanvasRenderer.js</a>, <a href="renderer_canvas_symbols_ShapeSymbolCanvasRenderer.js.html#line6">line 6</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="smartGuideLogger"><span class="type-signature">(constant) </span>smartGuideLogger<span class="type-signature"> :Object</span></h4>




<div class="description">
    Log editor events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_LoggerConfig.js.html">configuration/LoggerConfig.js</a>, <a href="configuration_LoggerConfig.js.html#line22">line 22</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="testLogger"><span class="type-signature">(constant) </span>testLogger<span class="type-signature"> :Object</span></h4>




<div class="description">
    Log tests events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_LoggerConfig.js.html">configuration/LoggerConfig.js</a>, <a href="configuration_LoggerConfig.js.html#line71">line 71</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="TextSymbols"><span class="type-signature">(constant) </span>TextSymbols<span class="type-signature"> :Object</span></h4>








<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_symbols_TextSymbolCanvasRenderer.js.html">renderer/canvas/symbols/TextSymbolCanvasRenderer.js</a>, <a href="renderer_canvas_symbols_TextSymbolCanvasRenderer.js.html#line7">line 7</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
            
<div class="section-members">
<h4 class="name" id="utilLogger"><span class="type-signature">(constant) </span>utilLogger<span class="type-signature"> :Object</span></h4>




<div class="description">
    Log util events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_LoggerConfig.js.html">configuration/LoggerConfig.js</a>, <a href="configuration_LoggerConfig.js.html#line64">line 64</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            
<div class="section-method">

    

    <h4 class="name" id="addListeners"><span class="type-signature"></span>addListeners<span class="signature">(editor, smartGuide)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Add the listeners to the smart guide elements.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="smartguide_SmartGuide.js.html">smartguide/SmartGuide.js</a>, <a href="smartguide_SmartGuide.js.html#line236">line 236</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                A reference to the editor.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>smartGuide</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#SmartGuide">SmartGuide</a></code></span>


            
            </td>

            

            

            <td class="description last">
                A reference to the smart guide.
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="addPoint"><span class="type-signature"></span>addPoint<span class="signature">(stroke, point)</span><span class="type-signature"> &rarr; {<a href="global.html#Stroke">Stroke</a>}</span></h4>

    



<div class="description">
    Mutate a stroke by adding a point to it.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_StrokeComponent.js.html">model/StrokeComponent.js</a>, <a href="model_StrokeComponent.js.html#line96">line 96</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>stroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current stroke
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Point to add
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Updated stroke
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="addStroke"><span class="type-signature"></span>addStroke<span class="signature">(model, stroke)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Mutate the model given in parameter by adding the new strokeToAdd.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line107">line 107</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Stroke to be added to pending ones
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Updated model
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="addStrokes"><span class="type-signature">(async) </span>addStrokes<span class="signature">(editor, model, trigger<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    



<div class="description">
    Launch the recognition with all editor relative configuration and state.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line61">line 61</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>trigger</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="addStrokes"><span class="type-signature"></span>addStrokes<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Add strokes to the model
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line425">line 425</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="addStrokeToGroup"><span class="type-signature"></span>addStrokeToGroup<span class="signature">(model, stroke, strokePenStyle)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Mutate the model given in parameter by adding the new strokeToAdd and the penstyle. Used for iink REST.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line122">line 122</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Stroke to be added to pending ones
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>strokePenStyle</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#PenStyle">PenStyle</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Updated model
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="addWebsocketAttributes"><span class="type-signature"></span>addWebsocketAttributes<span class="signature">(websocket, recognizerContext)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Attach all socket attributes helping managing server connexion
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_networkWSInterface.js.html">recognizer/websocket/networkWSInterface.js</a>, <a href="recognizer_websocket_networkWSInterface.js.html#line24">line 24</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>websocket</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>WebSocket</code></span>


            
            </td>

            

            

            <td class="description last">
                Current WebSocket
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="appendToPendingStroke"><span class="type-signature"></span>appendToPendingStroke<span class="signature">(model, point)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Mutate the model by adding a point to the current pending stroke.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line179">line 179</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Captured point to be append to the current stroke
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Updated model
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="attach"><span class="type-signature"></span>attach<span class="signature">(element, editor, offsetTop<span class="signature-attributes">opt</span>, offsetLeft<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="global.html#GrabberContext">GrabberContext</a>}</span></h4>

    



<div class="description">
    Listen for the desired events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="grabber_PointerEventGrabber.js.html">grabber/PointerEventGrabber.js</a>, <a href="grabber_PointerEventGrabber.js.html#line69">line 69</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>element</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Element</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                DOM element to attach events listeners
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Editor to received down/move/up events
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>offsetTop</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>offsetLeft</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>








<h5>Listens to Events:</h5>
<ul>
    <li>{Event} pointermove: a pointer moves,event: similar to touchmove or mousemove.</li>

    <li>{Event} pointerdown: a pointer is activated,event: or a device button held.</li>

    <li>{Event} pointerup: a pointer is deactivated,event: or a device button released.</li>

    <li>event:{Event} pointerover: a pointer has moved onto an element.</li>

    <li>event:{Event} pointerout: a pointer is no longer on an element it once was.</li>

    <li>event:{Event} pointerenter: a pointer enters the bounding box of an element.</li>

    <li>event:{Event} pointerleave: a pointer leaves the bounding box of an element.</li>

    <li>event:{Event} pointercancel: a pointer will no longer generate events.</li>
</ul>







<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#GrabberContext">GrabberContext</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Grabber context
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="attach"><span class="type-signature"></span>attach<span class="signature">(element, minHeight<span class="signature-attributes">opt</span>, minWidth<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h4>

    



<div class="description">
    Attach the renderer to the DOM element
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_CanvasRenderer.js.html">renderer/canvas/CanvasRenderer.js</a>, <a href="renderer_canvas_CanvasRenderer.js.html#line96">line 96</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>element</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Element</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                DOM element to attach the rendering elements
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minHeight</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">
                Minimal height of the editor
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minWidth</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">
                Minimal width of the editor
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Object</code></span>


    </dd>
</dl>


<div class="param-desc">
    The renderer context to give as parameter when a draw model will be call
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="attach"><span class="type-signature"></span>attach<span class="signature">(element)</span><span class="type-signature"> &rarr; {Object}</span></h4>

    



<div class="description">
    Populate the dom element
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_svg_SVGRenderer.js.html">renderer/svg/SVGRenderer.js</a>, <a href="renderer_svg_SVGRenderer.js.html#line21">line 21</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>element</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Element</code></span>


            
            </td>

            

            

            <td class="description last">
                DOM element to attach the rendering elements
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Object</code></span>


    </dd>
</dl>


<div class="param-desc">
    The renderer context to give as parameter when a draw model will be call
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="buildHmacMessage"><span class="type-signature"></span>buildHmacMessage<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    A websocket dialog have this sequence :
---------- Client ------------------------------------- Server ----------------------------------
init (send the new content package) ================>
                                      <=========== hmacChallenge
answerToHmacChallenge (send the hmac) =========>
newPart (send the parameters ) ===============>
                                      <=========== update
addStrokes (send the strokes ) ============>
                                      <=========== update
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_WsBuilder.js.html">recognizer/websocket/WsBuilder.js</a>, <a href="recognizer_websocket_WsBuilder.js.html#line25">line 25</a>
    </li></ul></dd>
    

    

    

    
</dl>























</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="buildWebSocketCallback"><span class="type-signature"></span>buildWebSocketCallback<span class="signature">(destructuredPromise, recognizerContext)</span><span class="type-signature"> &rarr; {function}</span></h4>

    



<div class="description">
    This function bind the right behaviour when a message is receive by the websocket.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_WsBuilder.js.html">recognizer/websocket/WsBuilder.js</a>, <a href="recognizer_websocket_WsBuilder.js.html#line38">line 38</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>destructuredPromise</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#DestructuredPromise">DestructuredPromise</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>function</code></span>


    </dd>
</dl>


<div class="param-desc">
    Callback to handle WebSocket results
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="callFadeOutObserver"><span class="type-signature"></span>callFadeOutObserver<span class="signature">(duration<span class="signature-attributes">opt</span>, smartGuide)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Call mutation observer to trigger fade out animation.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="smartguide_SmartGuide.js.html">smartguide/SmartGuide.js</a>, <a href="smartguide_SmartGuide.js.html#line260">line 260</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    10000
                
                </td>
            

            <td class="description last">
                the duration in milliseconds before calling the fade out animation.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>smartGuide</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#SmartGuide">SmartGuide</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                A reference to the smart guide.
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="canReconnect"><span class="type-signature"></span>canReconnect<span class="signature">(recognizerContext)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>

    



<div class="description">
    Test if it is possible to reconnect
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_RecognizerContext.js.html">model/RecognizerContext.js</a>, <a href="model_RecognizerContext.js.html#line121">line 121</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Boolean</code></span>


    </dd>
</dl>


<div class="param-desc">
    True if possible, false otherwise
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="signature">(recognizerContext, model)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    



<div class="description">
    Clear server context. Currently nothing to do there.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_DefaultRecognizer.js.html">recognizer/DefaultRecognizer.js</a>, <a href="recognizer_DefaultRecognizer.js.html#line102">line 102</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="signature">(recognizerContext, model, callback)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Do what is needed to clean the server context.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_WsRecognizerUtil.js.html">recognizer/websocket/WsRecognizerUtil.js</a>, <a href="recognizer_websocket_WsRecognizerUtil.js.html#line96">line 96</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerCallback">RecognizerCallback</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Clear action
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line453">line 453</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="clearModel"><span class="type-signature"></span>clearModel<span class="signature">(model)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Clear the model.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line77">line 77</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Cleared model
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="clickCandidate"><span class="type-signature"></span>clickCandidate<span class="signature">(evt, editor, smartGuide)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Call the import_ function of the editor to import the modified Jiix with the new label.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="smartguide_SmartGuide.js.html">smartguide/SmartGuide.js</a>, <a href="smartguide_SmartGuide.js.html#line217">line 217</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>evt</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Event</code></span>


            
            </td>

            

            

            <td class="description last">
                Event to determine the clicked candidate.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                A reference to the editor.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>smartGuide</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#SmartGuide">SmartGuide</a></code></span>


            
            </td>

            

            

            <td class="description last">
                A reference to the smart guide.
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="cloneModel"><span class="type-signature"></span>cloneModel<span class="signature">(model)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Clone model
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line329">line 329</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Clone of the current model
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="close"><span class="type-signature"></span>close<span class="signature">(recognizerContext, model)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    



<div class="description">
    Close and free all resources that will no longer be used by the recognizer.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_DefaultRecognizer.js.html">recognizer/DefaultRecognizer.js</a>, <a href="recognizer_DefaultRecognizer.js.html#line121">line 121</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="close"><span class="type-signature"></span>close<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Close and free all resources that will no longer be used by the recognizer.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_WsRecognizerUtil.js.html">recognizer/websocket/WsRecognizerUtil.js</a>, <a href="recognizer_websocket_WsRecognizerUtil.js.html#line119">line 119</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="close"><span class="type-signature"></span>close<span class="signature">(recognizerContext, code, reason)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Close the websocket
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_networkWSInterface.js.html">recognizer/websocket/networkWSInterface.js</a>, <a href="recognizer_websocket_networkWSInterface.js.html#line109">line 109</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>code</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">
                Exit code
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>reason</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                Exit reason
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="computeAxeAngle"><span class="type-signature"></span>computeAxeAngle<span class="signature">(begin, end)</span><span class="type-signature"> &rarr; {Number}</span></h4>

    







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_QuadraticUtils.js.html">renderer/QuadraticUtils.js</a>, <a href="renderer_QuadraticUtils.js.html#line43">line 43</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>begin</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>end</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Number</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="computeHmac"><span class="type-signature"></span>computeHmac<span class="signature">(input, applicationKey, hmacKey)</span><span class="type-signature"> &rarr; {String}</span></h4>

    



<div class="description">
    Compute HMAC signature for server authentication
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_CryptoHelper.js.html">recognizer/CryptoHelper.js</a>, <a href="recognizer_CryptoHelper.js.html#line13">line 13</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>input</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Input data to compute HMAC
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>applicationKey</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                Current applicationKey
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>hmacKey</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                Current hmacKey
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>String</code></span>


    </dd>
</dl>


<div class="param-desc">
    Signature
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="computeLinksPoints"><span class="type-signature"></span>computeLinksPoints<span class="signature">(point, angle, width)</span><span class="type-signature"> &rarr; {Object|Object}</span></h4>

    







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_QuadraticUtils.js.html">renderer/QuadraticUtils.js</a>, <a href="renderer_QuadraticUtils.js.html#line12">line 12</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>angle</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Object</code></span>
|

<span class="param-type"><code>Object</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="computeMiddlePoint"><span class="type-signature"></span>computeMiddlePoint<span class="signature">(point1, point2)</span><span class="type-signature"> &rarr; {Object}</span></h4>

    







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_QuadraticUtils.js.html">renderer/QuadraticUtils.js</a>, <a href="renderer_QuadraticUtils.js.html#line29">line 29</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>point1</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>point2</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Object</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="convert"><span class="type-signature"></span>convert<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Ask for conversion using DIGITAL_EDIT
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_rest_iinkRestRecognizer.js.html">recognizer/rest/iinkRestRecognizer.js</a>, <a href="recognizer_rest_iinkRestRecognizer.js.html#line207">line 207</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="convert"><span class="type-signature"></span>convert<span class="signature">(recognizerContext, model, conversionState)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Convert action
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line492">line 492</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>conversionState</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                Conversion State, by default DigitalEdit
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="createEmptyRecognizerContext"><span class="type-signature"></span>createEmptyRecognizerContext<span class="signature">(editor)</span><span class="type-signature"> &rarr; {<a href="global.html#RecognizerContext">RecognizerContext</a>}</span></h4>

    



<div class="description">
    Create a new recognizer context
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_RecognizerContext.js.html">model/RecognizerContext.js</a>, <a href="model_RecognizerContext.js.html#line40">line 40</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    An object that contains all recognizer context
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="createHTMLElements"><span class="type-signature"></span>createHTMLElements<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Create all the smart guide HTML elements.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="smartguide_SmartGuide.js.html">smartguide/SmartGuide.js</a>, <a href="smartguide_SmartGuide.js.html#line21">line 21</a>
    </li></ul></dd>
    

    

    

    
</dl>























</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="createModel"><span class="type-signature"></span>createModel<span class="signature">(configuration<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Create a new model
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line49">line 49</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>configuration</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Configuration</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                Parameters to use to populate default recognition symbols
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    New model
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="createSmartGuide"><span class="type-signature"></span>createSmartGuide<span class="signature">(editor)</span><span class="type-signature"> &rarr; {<a href="global.html#SmartGuide">SmartGuide</a>}</span></h4>

    



<div class="description">
    Create a new smart guide
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="smartguide_SmartGuide.js.html">smartguide/SmartGuide.js</a>, <a href="smartguide_SmartGuide.js.html#line290">line 290</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                A reference to the editor.
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#SmartGuide">SmartGuide</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    New smart guide
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="createStrokeComponent"><span class="type-signature"></span>createStrokeComponent<span class="signature">(properties)</span><span class="type-signature"> &rarr; {<a href="global.html#Stroke">Stroke</a>}</span></h4>

    



<div class="description">
    Create a new stroke
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_StrokeComponent.js.html">model/StrokeComponent.js</a>, <a href="model_StrokeComponent.js.html#line68">line 68</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>properties</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Properties to be applied to the stroke.
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    New stroke with properties for quadratics draw
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="createUndoRedoContext"><span class="type-signature"></span>createUndoRedoContext<span class="signature">(configuration)</span><span class="type-signature"> &rarr; {<a href="global.html#UndoRedoContext">UndoRedoContext</a>}</span></h4>

    



<div class="description">
    Create a new undo/redo context
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_UndoRedoContext.js.html">model/UndoRedoContext.js</a>, <a href="model_UndoRedoContext.js.html#line16">line 16</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>configuration</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Configuration</code></span>


            
            </td>

            

            

            <td class="description last">
                Current configuration
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#UndoRedoContext">UndoRedoContext</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    New undo/redo context
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="delay"><span class="type-signature"></span>delay<span class="signature">(time)</span><span class="type-signature"> &rarr; {Object}</span></h4>

    







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_PromiseHelper.js.html">util/PromiseHelper.js</a>, <a href="util_PromiseHelper.js.html#line27">line 27</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>time</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Object</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="destructurePromise"><span class="type-signature"></span>destructurePromise<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>

    



<div class="description">
    destructurePromise
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_PromiseHelper.js.html">util/PromiseHelper.js</a>, <a href="util_PromiseHelper.js.html#line12">line 12</a>
    </li></ul></dd>
    

    

    

    
</dl>





















<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Object</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="detach"><span class="type-signature"></span>detach<span class="signature">(element, context)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Detach the renderer from the DOM element
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_CanvasRenderer.js.html">renderer/canvas/CanvasRenderer.js</a>, <a href="renderer_canvas_CanvasRenderer.js.html#line121">line 121</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>element</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Element</code></span>


            
            </td>

            

            

            <td class="description last">
                DOM element to attach the rendering elements
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="detach"><span class="type-signature"></span>detach<span class="signature">(element, context)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Detach the renderer from the DOM element
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_svg_SVGRenderer.js.html">renderer/svg/SVGRenderer.js</a>, <a href="renderer_svg_SVGRenderer.js.html#line33">line 33</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>element</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Element</code></span>


            
            </td>

            

            

            <td class="description last">
                DOM element to attach the rendering elements
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawCurrentStroke"><span class="type-signature"></span>drawCurrentStroke<span class="signature">(context, model, stroker)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Draw the current stroke from the model
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_CanvasRenderer.js.html">renderer/canvas/CanvasRenderer.js</a>, <a href="renderer_canvas_CanvasRenderer.js.html#line159">line 159</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroker</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroker">Stroker</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current stroker
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawCurrentStroke"><span class="type-signature"></span>drawCurrentStroke<span class="signature">(context, model, stroker)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Draw the current stroke from the model
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_svg_SVGRenderer.js.html">renderer/svg/SVGRenderer.js</a>, <a href="renderer_svg_SVGRenderer.js.html#line66">line 66</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroker</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroker">Stroker</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current stroker
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawLine"><span class="type-signature"></span>drawLine<span class="signature">(context, p1, p2)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Draw a line
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_symbols_ShapeSymbolCanvasRenderer.js.html">renderer/canvas/symbols/ShapeSymbolCanvasRenderer.js</a>, <a href="renderer_canvas_symbols_ShapeSymbolCanvasRenderer.js.html#line115">line 115</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>p1</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Origin point
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>p2</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Destination point
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawMathSymbol"><span class="type-signature"></span>drawMathSymbol<span class="signature">(context, symbol, model, stroker)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Draw a math symbol
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_symbols_MathSymbolCanvasRenderer.js.html">renderer/canvas/symbols/MathSymbolCanvasRenderer.js</a>, <a href="renderer_canvas_symbols_MathSymbolCanvasRenderer.js.html#line28">line 28</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>symbol</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Symbol to draw
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroker</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroker">Stroker</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Stroker to use to render a stroke
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawModel"><span class="type-signature"></span>drawModel<span class="signature">(context, model, stroker)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Draw all symbols contained into the model
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_CanvasRenderer.js.html">renderer/canvas/CanvasRenderer.js</a>, <a href="renderer_canvas_CanvasRenderer.js.html#line174">line 174</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroker</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroker">Stroker</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current stroker
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawModel"><span class="type-signature"></span>drawModel<span class="signature">(context, model, stroker)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Draw all symbols contained into the model
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_svg_SVGRenderer.js.html">renderer/svg/SVGRenderer.js</a>, <a href="renderer_svg_SVGRenderer.js.html#line107">line 107</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroker</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroker">Stroker</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current stroker
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawShapeSymbol"><span class="type-signature"></span>drawShapeSymbol<span class="signature">(context, symbol)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Draw a shape symbol
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_symbols_ShapeSymbolCanvasRenderer.js.html">renderer/canvas/symbols/ShapeSymbolCanvasRenderer.js</a>, <a href="renderer_canvas_symbols_ShapeSymbolCanvasRenderer.js.html#line142">line 142</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>symbol</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Symbol to draw
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawStroke"><span class="type-signature"></span>drawStroke<span class="signature">(context, stroke)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Draw a stroke on a canvas, using quadratics
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_stroker_QuadraticCanvasStroker.js.html">renderer/canvas/stroker/QuadraticCanvasStroker.js</a>, <a href="renderer_canvas_stroker_QuadraticCanvasStroker.js.html#line71">line 71</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current stroke to be drawn
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawStroke"><span class="type-signature"></span>drawStroke<span class="signature">(context, stroke, stroker)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Draw a stroke symbol
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_symbols_StrokeSymbolCanvasRenderer.js.html">renderer/canvas/symbols/StrokeSymbolCanvasRenderer.js</a>, <a href="renderer_canvas_symbols_StrokeSymbolCanvasRenderer.js.html#line7">line 7</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Stroke to be drawn
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroker</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroker">Stroker</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Stroker to use to render a stroke
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawStroke"><span class="type-signature"></span>drawStroke<span class="signature">(context, stroke)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Draw a stroke on a svg tag, using quadratics
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_svg_stroker_QuadraticSVGStroker.js.html">renderer/svg/stroker/QuadraticSVGStroker.js</a>, <a href="renderer_svg_stroker_QuadraticSVGStroker.js.html#line71">line 71</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current stroke to be drawn
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawStroke"><span class="type-signature"></span>drawStroke<span class="signature">(context, stroke, stroker)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Draw a stroke symbol
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_svg_symbols_StrokeSymbolSVGRenderer.js.html">renderer/svg/symbols/StrokeSymbolSVGRenderer.js</a>, <a href="renderer_svg_symbols_StrokeSymbolSVGRenderer.js.html#line7">line 7</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Stroke to be drawn
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroker</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroker">Stroker</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Stroker to use to render a stroke
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="drawTextSymbol"><span class="type-signature"></span>drawTextSymbol<span class="signature">(context, symbol)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Draw a text symbol
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_symbols_TextSymbolCanvasRenderer.js.html">renderer/canvas/symbols/TextSymbolCanvasRenderer.js</a>, <a href="renderer_canvas_symbols_TextSymbolCanvasRenderer.js.html#line53">line 53</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>symbol</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Symbol to draw
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="emitEvents"><span class="type-signature"></span>emitEvents<span class="signature">(editor, data, &hellip;types)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Emit events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_RecognizerService.js.html">recognizer/RecognizerService.js</a>, <a href="recognizer_RecognizerService.js.html#line15">line 15</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>types</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                    &lt;repeatable><br>
                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="endPendingStroke"><span class="type-signature"></span>endPendingStroke<span class="signature">(model, point, penStyle)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Mutate the model by adding the new point on a initPendingStroke.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line195">line 195</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Captured point to be append to the current stroke
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>penStyle</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#PenStyle">PenStyle</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Updated model
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="export_"><span class="type-signature"></span>export_<span class="signature">(recognizerContext, model, requestedMimeTypes)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Export content
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_rest_iinkRestRecognizer.js.html">recognizer/rest/iinkRestRecognizer.js</a>, <a href="recognizer_rest_iinkRestRecognizer.js.html#line186">line 186</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>requestedMimeTypes</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="export_"><span class="type-signature"></span>export_<span class="signature">(recognizerContext, model, requestedMimeTypes)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Export action
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line503">line 503</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>requestedMimeTypes</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="extractPendingRecognizedSymbols"><span class="type-signature"></span>extractPendingRecognizedSymbols<span class="signature">(model, position<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;Object>}</span></h4>

    



<div class="description">
    Get the symbols that needs to be rendered
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line320">line 320</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    lastRendered
                
                </td>
            

            <td class="description last">
                Index from where to extract symbols
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Array.&lt;Object></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="extractPendingStrokes"><span class="type-signature"></span>extractPendingStrokes<span class="signature">(model, position<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="global.html#Stroke">Stroke</a>>}</span></h4>

    



<div class="description">
    Get the strokes that needs to be recognized
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line148">line 148</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    lastReceived
                
                </td>
            

            <td class="description last">
                Index from where to extract strokes
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Array.&lt;<a href="global.html#Stroke">Stroke</a>></code></span>


    </dd>
</dl>


<div class="param-desc">
    Pending strokes
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="extractStrokesFromInkRange"><span class="type-signature"></span>extractStrokesFromInkRange<span class="signature">(model, firstStroke, lastStroke, firstPoint, lastPoint)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="global.html#Stroke">Stroke</a>>}</span></h4>

    



<div class="description">
    Extract strokes from an ink range
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line241">line 241</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>firstStroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">
                First stroke index to extract
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lastStroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">
                Last stroke index to extract
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>firstPoint</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">
                First point index to extract
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lastPoint</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">
                Last point index to extract
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Array.&lt;<a href="global.html#Stroke">Stroke</a>></code></span>


    </dd>
</dl>


<div class="param-desc">
    The extracted strokes
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getAvailableLanguageList"><span class="type-signature"></span>getAvailableLanguageList<span class="signature">(configuration<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {JSON}</span></h4>

    



<div class="description">
    Return the list of available recognition languages
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="EditorFacade.js.html">EditorFacade.js</a>, <a href="EditorFacade.js.html#line23">line 23</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>configuration</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Configuration</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                Configuration to get the languages
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>JSON</code></span>


    </dd>
</dl>


<div class="param-desc">
    A list of available languages
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getBorderCoordinates"><span class="type-signature"></span>getBorderCoordinates<span class="signature">(model)</span><span class="type-signature"> &rarr; {<a href="global.html#Bounds">Bounds</a>}</span></h4>

    



<div class="description">
    Get the bounds of the current model.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line214">line 214</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Bounds">Bounds</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Bounding box enclosing the current drawn model
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getImage"><span class="type-signature"></span>getImage<span class="signature">(model, stroker, margin<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {String}</span></h4>

    



<div class="description">
    Generate a PNG image data url from the model
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_ImageRenderer.js.html">renderer/canvas/ImageRenderer.js</a>, <a href="renderer_canvas_ImageRenderer.js.html#line22">line 22</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroker</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroker">Stroker</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Current stroker
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>margin</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    10
                
                </td>
            

            <td class="description last">
                Margins to apply around the image
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>String</code></span>


    </dd>
</dl>


<div class="param-desc">
    Image data string result
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getInfo"><span class="type-signature"></span>getInfo<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#RecognizerInfo">RecognizerInfo</a>}</span></h4>

    



<div class="description">
    Get the configuration supported by this recognizer
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_rest_iinkRestRecognizer.js.html">recognizer/rest/iinkRestRecognizer.js</a>, <a href="recognizer_rest_iinkRestRecognizer.js.html#line33">line 33</a>
    </li></ul></dd>
    

    

    

    
</dl>





















<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#RecognizerInfo">RecognizerInfo</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getInfo"><span class="type-signature"></span>getInfo<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#RecognizerInfo">RecognizerInfo</a>}</span></h4>

    



<div class="description">
    Get the configuration supported by this recognizer
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line53">line 53</a>
    </li></ul></dd>
    

    

    

    
</dl>





















<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#RecognizerInfo">RecognizerInfo</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getInfo"><span class="type-signature"></span>getInfo<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#RendererInfo">RendererInfo</a>}</span></h4>

    



<div class="description">
    Get info
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_CanvasRenderer.js.html">renderer/canvas/CanvasRenderer.js</a>, <a href="renderer_canvas_CanvasRenderer.js.html#line29">line 29</a>
    </li></ul></dd>
    

    

    

    
</dl>





















<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#RendererInfo">RendererInfo</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Information about this renderer
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getInfo"><span class="type-signature"></span>getInfo<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#StrokerInfo">StrokerInfo</a>}</span></h4>

    



<div class="description">
    Get info
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_stroker_QuadraticCanvasStroker.js.html">renderer/canvas/stroker/QuadraticCanvasStroker.js</a>, <a href="renderer_canvas_stroker_QuadraticCanvasStroker.js.html#line23">line 23</a>
    </li></ul></dd>
    

    

    

    
</dl>





















<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#StrokerInfo">StrokerInfo</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Information about this stroker
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getInfo"><span class="type-signature"></span>getInfo<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#RendererInfo">RendererInfo</a>}</span></h4>

    



<div class="description">
    Get info
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_svg_SVGRenderer.js.html">renderer/svg/SVGRenderer.js</a>, <a href="renderer_svg_SVGRenderer.js.html#line10">line 10</a>
    </li></ul></dd>
    

    

    

    
</dl>





















<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#RendererInfo">RendererInfo</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Information about this renderer
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getInfo"><span class="type-signature"></span>getInfo<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#StrokerInfo">StrokerInfo</a>}</span></h4>

    



<div class="description">
    Get info
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_svg_stroker_QuadraticSVGStroker.js.html">renderer/svg/stroker/QuadraticSVGStroker.js</a>, <a href="renderer_svg_stroker_QuadraticSVGStroker.js.html#line8">line 8</a>
    </li></ul></dd>
    

    

    

    
</dl>





















<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#StrokerInfo">StrokerInfo</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Information about this stroker
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getModel"><span class="type-signature"></span>getModel<span class="signature">(undoRedoContext, clone<span class="signature-attributes">opt</span>, &hellip;types)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Get current model in stack
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_UndoRedoManager.js.html">model/UndoRedoManager.js</a>, <a href="model_UndoRedoManager.js.html#line21">line 21</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>undoRedoContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#UndoRedoContext">UndoRedoContext</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Current undo/redo context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>clone</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Boolean</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last">
                Whether or not to clone the model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>types</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                    &lt;repeatable><br>
                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getPointByIndex"><span class="type-signature"></span>getPointByIndex<span class="signature">(stroke, index)</span><span class="type-signature"> &rarr; {Object}</span></h4>

    



<div class="description">
    Extract point by index
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_StrokeComponent.js.html">model/StrokeComponent.js</a>, <a href="model_StrokeComponent.js.html#line135">line 135</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>stroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current stroke
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">
                Zero-based index
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Object</code></span>


    </dd>
</dl>


<div class="param-desc">
    Point with properties for quadratics draw
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getSupportedImportMimeTypes"><span class="type-signature"></span>getSupportedImportMimeTypes<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Ask for the supported mimetypes
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line545">line 545</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="getSymbolsBounds"><span class="type-signature"></span>getSymbolsBounds<span class="signature">(symbols, bounds<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="global.html#Bounds">Bounds</a>}</span></h4>

    



<div class="description">
    Get the box enclosing the given symbols
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_Symbol.js.html">model/Symbol.js</a>, <a href="model_Symbol.js.html#line88">line 88</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>symbols</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                Symbols to extract bounds from
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>bounds</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Bounds">Bounds</a></code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                Starting bounds for recursion
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Bounds">Bounds</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Bounding box enclosing symbols
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="handleError"><span class="type-signature"></span>handleError<span class="signature">(editor, err, &hellip;events)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Method called when server respond with an error
Use in catch on Promises
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_RecognizerService.js.html">recognizer/RecognizerService.js</a>, <a href="recognizer_RecognizerService.js.html#line117">line 117</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>err</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>events</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                    &lt;repeatable><br>
                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="handleSuccess"><span class="type-signature"></span>handleSuccess<span class="signature">(editor, model, &hellip;events)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Method called when server respond correctly to request or WS
Use in then on Promises
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_RecognizerService.js.html">recognizer/RecognizerService.js</a>, <a href="recognizer_RecognizerService.js.html#line156">line 156</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>events</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                    &lt;repeatable><br>
                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="import_"><span class="type-signature"></span>import_<span class="signature">(recognizerContext, model, data)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Import action
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line515">line 515</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Blob</code></span>


            
            </td>

            

            

            <td class="description last">
                Import data
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(recognizerContext, model)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    



<div class="description">
    Initialize recognition
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_DefaultRecognizer.js.html">recognizer/DefaultRecognizer.js</a>, <a href="recognizer_DefaultRecognizer.js.html#line65">line 65</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(suffixUrl, recognizerContext, buildWebSocketCallback, reconnect)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    



<div class="description">
    Init the websocket recognizer.
Open the connexion and proceed to the hmac challenge.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_WsRecognizerUtil.js.html">recognizer/websocket/WsRecognizerUtil.js</a>, <a href="recognizer_websocket_WsRecognizerUtil.js.html#line35">line 35</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>suffixUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>buildWebSocketCallback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#BuildWebSocketFunction">BuildWebSocketFunction</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>reconnect</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise</code></span>


    </dd>
</dl>


<div class="param-desc">
    Fulfilled when the init phase is over.
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Initialize recognition
The init process is in multiple part :
- partChange
- contentChange
- initPromise: resolved only if partChange & contentChange resolved except for MATH recognition
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line283">line 283</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="initPendingStroke"><span class="type-signature"></span>initPendingStroke<span class="signature">(model, point, properties, dpi<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Mutate the model by adding a point and close the current stroke.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line160">line 160</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Captured point to create current stroke
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>properties</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Properties to be applied to the current stroke
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>dpi</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    96
                
                </td>
            

            <td class="description last">
                The screen dpi resolution
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Updated model
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="inkImporter"><span class="type-signature"></span>inkImporter<span class="signature">(editorParam, strokes, delayBetweenStrokes, lastOneDelay)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Function to copy past to inject ink during tutorial.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="eastereggs_InkImporter.js.html">eastereggs/InkImporter.js</a>, <a href="eastereggs_InkImporter.js.html#line12">line 12</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editorParam</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>strokes</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>delayBetweenStrokes</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lastOneDelay</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="insertSmartGuide"><span class="type-signature"></span>insertSmartGuide<span class="signature">(smartGuide)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Insert the smart guide HTML elements in the DOM.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="smartguide_SmartGuide.js.html">smartguide/SmartGuide.js</a>, <a href="smartguide_SmartGuide.js.html#line346">line 346</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>smartGuide</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#SmartGuide">SmartGuide</a></code></span>


            
            </td>

            

            

            <td class="description last">
                A reference to the smart guide.
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="isInShadow"><span class="type-signature"></span>isInShadow<span class="signature">(node)</span><span class="type-signature"> &rarr; {boolean}</span></h4>

    



<div class="description">
    Check if node is in shadow dom
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="smartguide_SmartGuide.js.html">smartguide/SmartGuide.js</a>, <a href="smartguide_SmartGuide.js.html#line128">line 128</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>node</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Node</code></span>


            
            </td>

            

            

            <td class="description last">
                A node element.
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>boolean</code></span>


    </dd>
</dl>


<div class="param-desc">
    true if is in shadow dom, false otherwise.
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="isResetRequired"><span class="type-signature"></span>isResetRequired<span class="signature">(recognizerContext, model)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>

    



<div class="description">
    Return true if a reset is required, false otherwise
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_RecognizerContext.js.html">model/RecognizerContext.js</a>, <a href="model_RecognizerContext.js.html#line79">line 79</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Boolean</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="isTriggerValid"><span class="type-signature"></span>isTriggerValid<span class="signature">(editor, type, trigger<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>

    



<div class="description">
    Check if the trigger in parameter is valid.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line45">line 45</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>trigger</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Boolean</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="launchClose"><span class="type-signature">(async) </span>launchClose<span class="signature">(editor, model)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>

    



<div class="description">
    Launch websocket close
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line233">line 233</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;*></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="launchConfig"><span class="type-signature">(async) </span>launchConfig<span class="signature">(editor, model)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>

    



<div class="description">
    Launch the configuration for the editor
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line180">line 180</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;*></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="launchConvert"><span class="type-signature">(async) </span>launchConvert<span class="signature">(editor, model, conversionState)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>

    



<div class="description">
    Launch the convert with all editor relative configuration and state.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line164">line 164</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>conversionState</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;*></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="launchExport"><span class="type-signature"></span>launchExport<span class="signature">(editor, model, requestedMimeTypes<span class="signature-attributes">opt</span>, trigger<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Launch the recognition with all editor relative configuration and state.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line102">line 102</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>requestedMimeTypes</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>trigger</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="launchGetSupportedImportMimeTypes"><span class="type-signature">(async) </span>launchGetSupportedImportMimeTypes<span class="signature">(editor, model)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>

    



<div class="description">
    Get the supported mimetypes for import.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line147">line 147</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;*></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="launchImport"><span class="type-signature">(async) </span>launchImport<span class="signature">(editor, model, data)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>

    



<div class="description">
    Launch the import.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line131">line 131</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Blob</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;*></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="launchPointerEvents"><span class="type-signature">(async) </span>launchPointerEvents<span class="signature">(editor, model, events)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>

    



<div class="description">
    Launch ink import.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line85">line 85</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>events</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>PointerEvents</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;*></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="launchResize"><span class="type-signature">(async) </span>launchResize<span class="signature">(editor, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Launch the resize.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line195">line 195</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="launchSmartGuide"><span class="type-signature"></span>launchSmartGuide<span class="signature">(smartGuide, exports)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Launch the smartguide.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="smartguide_SmartGuide.js.html">smartguide/SmartGuide.js</a>, <a href="smartguide_SmartGuide.js.html#line418">line 418</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>smartGuide</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#SmartGuide">SmartGuide</a></code></span>


            
            </td>

            

            

            <td class="description last">
                A reference to the smart guide.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>exports</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                The export from the editor.
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="launchWaitForIdle"><span class="type-signature">(async) </span>launchWaitForIdle<span class="signature">(editor, model)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>

    



<div class="description">
    Launch wait for idle
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line217">line 217</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;*></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="manageRecognizedModel"><span class="type-signature"></span>manageRecognizedModel<span class="signature">(editor, model, &hellip;types)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Manage recognized model
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_RecognizerService.js.html">recognizer/RecognizerService.js</a>, <a href="recognizer_RecognizerService.js.html#line76">line 76</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>types</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                    &lt;repeatable><br>
                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="manageResetState"><span class="type-signature"></span>manageResetState<span class="signature">(editor, model)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>

    



<div class="description">
    Check if a clear is required, and does it if it is
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line30">line 30</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;*></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="mergeModels"><span class="type-signature"></span>mergeModels<span class="signature">(&hellip;models)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Merge models
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line348">line 348</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>models</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                    &lt;repeatable><br>
                
                </td>
            

            

            <td class="description last">
                Models to merge (ordered)
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Updated model
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="needRedraw"><span class="type-signature"></span>needRedraw<span class="signature">(model)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>

    



<div class="description">
    Check if the model needs to be redrawn.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line97">line 97</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Boolean</code></span>


    </dd>
</dl>


<div class="param-desc">
    True if the model needs to be redrawn, false otherwise
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="newContentPart"><span class="type-signature"></span>newContentPart<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Create a new content part
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line387">line 387</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="openContentPart"><span class="type-signature"></span>openContentPart<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Open the recognizer context content part
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line396">line 396</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="openWebSocket"><span class="type-signature"></span>openWebSocket<span class="signature">(recognizerContext)</span><span class="type-signature"> &rarr; {WebSocket}</span></h4>

    







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_networkWSInterface.js.html">recognizer/websocket/networkWSInterface.js</a>, <a href="recognizer_websocket_networkWSInterface.js.html#line41">line 41</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Recognizer context
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>WebSocket</code></span>


    </dd>
</dl>


<div class="param-desc">
    Opened WebSocket
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="overrideDefaultBehaviors"><span class="type-signature"></span>overrideDefaultBehaviors<span class="signature">(behaviors)</span><span class="type-signature"> &rarr; {<a href="global.html#Behaviors">Behaviors</a>}</span></h4>

    



<div class="description">
    Generate behaviors
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultBehaviors.js.html">configuration/DefaultBehaviors.js</a>, <a href="configuration_DefaultBehaviors.js.html#line66">line 66</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>behaviors</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Behaviors">Behaviors</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Behaviors to be used
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Behaviors">Behaviors</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Overridden behaviors
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="overrideDefaultConfiguration"><span class="type-signature"></span>overrideDefaultConfiguration<span class="signature">(configuration, watcher:)</span><span class="type-signature"> &rarr; {Configuration}</span></h4>

    



<div class="description">
    Generate parameters
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultConfiguration.js.html">configuration/DefaultConfiguration.js</a>, <a href="configuration_DefaultConfiguration.js.html#line130">line 130</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>configuration</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Configuration</code></span>


            
            </td>

            

            

            <td class="description last">
                Configuration to be used
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>watcher:</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                { update: function, prop: string} function to call when 'prop' is updated
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Configuration</code></span>


    </dd>
</dl>


<div class="param-desc">
    Overridden configuration
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="overrideDefaultPenStyle"><span class="type-signature"></span>overrideDefaultPenStyle<span class="signature">(style)</span><span class="type-signature"> &rarr; {<a href="global.html#PenStyle">PenStyle</a>}</span></h4>

    



<div class="description">
    Generate style
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultPenStyle.js.html">configuration/DefaultPenStyle.js</a>, <a href="configuration_DefaultPenStyle.js.html#line25">line 25</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>style</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#PenStyle">PenStyle</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Custom style to be applied
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#PenStyle">PenStyle</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Overridden style
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="overrideDefaultTheme"><span class="type-signature"></span>overrideDefaultTheme<span class="signature">(theme)</span><span class="type-signature"> &rarr; {<a href="global.html#Theme">Theme</a>}</span></h4>

    



<div class="description">
    Generate theme
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultTheme.js.html">configuration/DefaultTheme.js</a>, <a href="configuration_DefaultTheme.js.html#line60">line 60</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>theme</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Theme">Theme</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Custom theme to be applied
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Theme">Theme</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Overridden theme
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="pointerEvents"><span class="type-signature"></span>pointerEvents<span class="signature">(recognizerContext, model, events)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Pointer Events
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line416">line 416</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>events</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>PointerEvents</code></span>


            
            </td>

            

            

            <td class="description last">
                to be imported
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="post"><span class="type-signature"></span>post<span class="signature">(recognizerContext, url, data, apiVersion, mimeType)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    



<div class="description">
    Post request
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_rest_networkInterface.js.html">recognizer/rest/networkInterface.js</a>, <a href="recognizer_rest_networkInterface.js.html#line13">line 13</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                URL
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Data to be sent
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>apiVersion</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                api version
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>mimeType</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                MimeType to be used
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="postMessage"><span class="type-signature"></span>postMessage<span class="signature">(suffixUrl, recognizerContext, model, buildMessage, conversionState, mimeType)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#Model">Model</a>>}</span></h4>

    







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_rest_iinkRestRecognizer.js.html">recognizer/rest/iinkRestRecognizer.js</a>, <a href="recognizer_rest_iinkRestRecognizer.js.html#line46">line 46</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>suffixUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>buildMessage</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>conversionState</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>mimeType</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;<a href="global.html#Model">Model</a>></code></span>


    </dd>
</dl>


<div class="param-desc">
    Promise that return an updated model as a result
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="redo"><span class="type-signature"></span>redo<span class="signature">(undoRedoContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Redo
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_UndoRedoManager.js.html">model/UndoRedoManager.js</a>, <a href="model_UndoRedoManager.js.html#line83">line 83</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>undoRedoContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#UndoRedoContext">UndoRedoContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current undo/redo context.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model.
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="redo"><span class="type-signature"></span>redo<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Redo last action
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line444">line 444</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="register"><span class="type-signature"></span>register<span class="signature">(element, configuration<span class="signature-attributes">opt</span>, penStyle<span class="signature-attributes">opt</span>, theme<span class="signature-attributes">opt</span>, behaviors<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="Editor.html">Editor</a>}</span></h4>

    



<div class="description">
    Attach an Editor to a DOMElement
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="EditorFacade.js.html">EditorFacade.js</a>, <a href="EditorFacade.js.html#line13">line 13</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>element</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Element</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                DOM element to attach an editor
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>configuration</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Configuration</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                Configuration to apply
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>penStyle</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#PenStyle">PenStyle</a></code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                Pen style to apply
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>theme</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Theme">Theme</a></code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                Theme to apply
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>behaviors</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Behaviors">Behaviors</a></code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                Custom behaviors to apply
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    New editor
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">(recognizerContext, model)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    



<div class="description">
    Reset server context. Currently nothing to do there.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_DefaultRecognizer.js.html">recognizer/DefaultRecognizer.js</a>, <a href="recognizer_DefaultRecognizer.js.html#line85">line 85</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="resetModelPositions"><span class="type-signature"></span>resetModelPositions<span class="signature">(model)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Reset model lastReceivedPosition and lastSentPosition
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line284">line 284</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="resetModelRendererPosition"><span class="type-signature"></span>resetModelRendererPosition<span class="signature">(model)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Reset model lastRenderedPosition
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line296">line 296</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="resize"><span class="type-signature"></span>resize<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Resize
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_rest_iinkRestRecognizer.js.html">recognizer/rest/iinkRestRecognizer.js</a>, <a href="recognizer_rest_iinkRestRecognizer.js.html#line219">line 219</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="resize"><span class="type-signature"></span>resize<span class="signature">(recognizerContext, model, element)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Resize
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line564">line 564</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>element</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Element</code></span>


            
            </td>

            

            

            <td class="description last">
                Current element
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="resize"><span class="type-signature"></span>resize<span class="signature">(context, model, stroker)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Update the rendering context size
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_CanvasRenderer.js.html">renderer/canvas/CanvasRenderer.js</a>, <a href="renderer_canvas_CanvasRenderer.js.html#line134">line 134</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroker</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroker">Stroker</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current stroker
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="resize"><span class="type-signature"></span>resize<span class="signature">(context, model, stroker, minHeight, minWidth)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Update the rendering context size
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_svg_SVGRenderer.js.html">renderer/svg/SVGRenderer.js</a>, <a href="renderer_svg_SVGRenderer.js.html#line47">line 47</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Current rendering context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stroker</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroker">Stroker</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current stroker
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minHeight</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">
                Minimal height for resize
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minWidth</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">
                Minimal Width for resize
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="send"><span class="type-signature"></span>send<span class="signature">(recognizerContext, message)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Send data message
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_networkWSInterface.js.html">recognizer/websocket/networkWSInterface.js</a>, <a href="recognizer_websocket_networkWSInterface.js.html#line90">line 90</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>message</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                Data message
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="sendConfiguration"><span class="type-signature"></span>sendConfiguration<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Send the recognizer configuration
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line406">line 406</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="sendMessage"><span class="type-signature"></span>sendMessage<span class="signature">(recognizerContext, buildMessage, &hellip;params)</span><span class="type-signature"> &rarr; {Promise}</span></h4>

    







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_WsRecognizerUtil.js.html">recognizer/websocket/WsRecognizerUtil.js</a>, <a href="recognizer_websocket_WsRecognizerUtil.js.html#line73">line 73</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>buildMessage</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>params</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                    &lt;repeatable><br>
                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise</code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="setPenStyle"><span class="type-signature">(async) </span>setPenStyle<span class="signature">(editor, model)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>

    



<div class="description">
    Set pen style.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line249">line 249</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;*></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="setPenStyle"><span class="type-signature"></span>setPenStyle<span class="signature">(recognizerContext, model, penStyle)</span><span class="type-signature"></span></h4>

    



<div class="description">
    SetPenStyle action
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line585">line 585</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>penStyle</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#PenStyle">PenStyle</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current penStyle
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="setPenStyleClasses"><span class="type-signature">(async) </span>setPenStyleClasses<span class="signature">(editor, model)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>

    



<div class="description">
    Set pen style.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line266">line 266</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;*></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="setPenStyleClasses"><span class="type-signature"></span>setPenStyleClasses<span class="signature">(recognizerContext, model, penStyleClasses)</span><span class="type-signature"></span></h4>

    



<div class="description">
    setPenStyleClasses action
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line595">line 595</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>penStyleClasses</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">
                Current penStyleClasses
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="setRecognitionContext"><span class="type-signature"></span>setRecognitionContext<span class="signature">(recognizerContext, recognitionContext)</span><span class="type-signature"> &rarr; {<a href="global.html#RecognizerContext">RecognizerContext</a>}</span></h4>

    



<div class="description">
    Set the recognition context
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_RecognizerContext.js.html">model/RecognizerContext.js</a>, <a href="model_RecognizerContext.js.html#line110">line 110</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>recognitionContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognitionContext">RecognitionContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="setTheme"><span class="type-signature">(async) </span>setTheme<span class="signature">(editor, model)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>

    



<div class="description">
    Set theme.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="Editor.js.html">Editor.js</a>, <a href="Editor.js.html#line283">line 283</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Promise.&lt;*></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="setTheme"><span class="type-signature"></span>setTheme<span class="signature">(recognizerContext, model, theme)</span><span class="type-signature"></span></h4>

    



<div class="description">
    SetTheme action
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line605">line 605</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>theme</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Theme">Theme</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current theme
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="shouldAttemptImmediateReconnect"><span class="type-signature"></span>shouldAttemptImmediateReconnect<span class="signature">(recognizerContext)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>

    



<div class="description">
    Test if it should attempt immediate reconnect
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_RecognizerContext.js.html">model/RecognizerContext.js</a>, <a href="model_RecognizerContext.js.html#line130">line 130</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Boolean</code></span>


    </dd>
</dl>


<div class="param-desc">
    True if should attempt reconnect, false otherwise
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="showActions"><span class="type-signature"></span>showActions<span class="signature">(evt, elements, smartGuide)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Show the actions of the action menu.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="smartguide_SmartGuide.js.html">smartguide/SmartGuide.js</a>, <a href="smartguide_SmartGuide.js.html#line145">line 145</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>evt</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Event</code></span>


            
            </td>

            

            

            <td class="description last">
                Event used to insert the option div using the event's target.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>elements</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">
                All the elements of the smart guide.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>smartGuide</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#SmartGuide">SmartGuide</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="showCandidates"><span class="type-signature"></span>showCandidates<span class="signature">(evt, editor, smartGuide)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Show the candidates of the clicked word.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="smartguide_SmartGuide.js.html">smartguide/SmartGuide.js</a>, <a href="smartguide_SmartGuide.js.html#line180">line 180</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>evt</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Event</code></span>


            
            </td>

            

            

            <td class="description last">
                Event used to determine the clicked word.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">
                A reference to the editor.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>smartGuide</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#SmartGuide">SmartGuide</a></code></span>


            
            </td>

            

            

            <td class="description last">
                A reference to the smart guide.
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="slice"><span class="type-signature"></span>slice<span class="signature">(stroke, start<span class="signature-attributes">opt</span>, end<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="global.html#Stroke">Stroke</a>}</span></h4>

    



<div class="description">
    Slice a stroke and return the sliced part of it
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_StrokeComponent.js.html">model/StrokeComponent.js</a>, <a href="model_StrokeComponent.js.html#line117">line 117</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>stroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Current stroke
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>start</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">
                Zero-based index at which to begin extraction
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>end</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    length
                
                </td>
            

            <td class="description last">
                Zero-based index at which to end extraction
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Sliced stroke
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">(stroke)</span><span class="type-signature"> &rarr; {Object}</span></h4>

    



<div class="description">
    Get a JSON copy of a stroke by filtering its properties
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_StrokeComponent.js.html">model/StrokeComponent.js</a>, <a href="model_StrokeComponent.js.html#line86">line 86</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>stroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current stroke
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code>Object</code></span>


    </dd>
</dl>


<div class="param-desc">
    Simplified stroke object
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="undo"><span class="type-signature"></span>undo<span class="signature">(undoRedoContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Undo
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_UndoRedoManager.js.html">model/UndoRedoManager.js</a>, <a href="model_UndoRedoManager.js.html#line68">line 68</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>undoRedoContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#UndoRedoContext">UndoRedoContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current undo/redo context.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model.
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="undo"><span class="type-signature"></span>undo<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Undo last action
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line435">line 435</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="updateModel"><span class="type-signature"></span>updateModel<span class="signature">(undoRedoContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Mutate the undoRedo stack by adding a new model to it.
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_UndoRedoManager.js.html">model/UndoRedoManager.js</a>, <a href="model_UndoRedoManager.js.html#line35">line 35</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>undoRedoContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#UndoRedoContext">UndoRedoContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current undo/redo context.
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model.
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="updateModelReceivedPosition"><span class="type-signature"></span>updateModelReceivedPosition<span class="signature">(model)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Update model lastReceivedPosition regarding to lastSentPosition
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line273">line 273</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="updateModelRenderedPosition"><span class="type-signature"></span>updateModelRenderedPosition<span class="signature">(model, position<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Update model lastRenderedPosition
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line308">line 308</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="updateModelSentPosition"><span class="type-signature"></span>updateModelSentPosition<span class="signature">(model, position<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="global.html#Model">Model</a>}</span></h4>

    



<div class="description">
    Update model lastSentPosition
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line262">line 262</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="updateRecognitionPositions"><span class="type-signature"></span>updateRecognitionPositions<span class="signature">(recognizerContext, positions)</span><span class="type-signature"> &rarr; {<a href="global.html#RecognizerContext">RecognizerContext</a>}</span></h4>

    



<div class="description">
    Update the recognition context positions
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_RecognizerContext.js.html">model/RecognizerContext.js</a>, <a href="model_RecognizerContext.js.html#line92">line 92</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognizer context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>positions</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognitionPositions">RecognitionPositions</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition positions
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


    </dd>
</dl>


    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="updateUndoRedoState"><span class="type-signature"></span>updateUndoRedoState<span class="signature">(undoRedoContext)</span><span class="type-signature"> &rarr; {<a href="global.html#UndoRedoContext">UndoRedoContext</a>}</span></h4>

    



<div class="description">
    Update the undo/redo state
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_UndoRedoContext.js.html">model/UndoRedoContext.js</a>, <a href="model_UndoRedoContext.js.html#line31">line 31</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>undoRedoContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#UndoRedoContext">UndoRedoContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current undo/redo context
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#UndoRedoContext">UndoRedoContext</a></code></span>


    </dd>
</dl>


<div class="param-desc">
    Updated undo/redo context
</div>

    
</div>



</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="waitForIdle"><span class="type-signature"></span>waitForIdle<span class="signature">(recognizerContext, model)</span><span class="type-signature"></span></h4>

    



<div class="description">
    WaitForIdle action
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line554">line 554</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
            
<div class="section-method">

    

    <h4 class="name" id="zoom"><span class="type-signature"></span>zoom<span class="signature">(recognizerContext, model, value)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Zoom action
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_iinkWsRecognizer.js.html">recognizer/websocket/iinkWsRecognizer.js</a>, <a href="recognizer_websocket_iinkWsRecognizer.js.html#line575">line 575</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Current recognition context
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">
                Current model
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                    10
                
                </td>
            

            <td class="description last">
                Zoom value
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
        
    

    
        <h3 class="subsection-title">Type Definitions</h3>

        
                
<div class="section-members">
<h4 class="name" id="Behavior">Behavior</h4>




<div class="description">
    Current behavior
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>grabber</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Grabber">Grabber</a></code></span>


            
            </td>

            

            

            <td class="description last">Grabber to capture strokes</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>stroker</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroker">Stroker</a></code></span>


            
            </td>

            

            

            <td class="description last">Stroker to draw stroke</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>renderer</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Renderer">Renderer</a></code></span>


            
            </td>

            

            

            <td class="description last">Renderer to draw on the editor</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>recognizer</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Recognizer">Recognizer</a></code></span>


            
            </td>

            

            

            <td class="description last">Recognizer to call the recognition service</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>events</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array</code></span>


            
            </td>

            

            

            <td class="description last">Functions to handle model changes</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultBehaviors.js.html">configuration/DefaultBehaviors.js</a>, <a href="configuration_DefaultBehaviors.js.html#line11">line 11</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="Behaviors">Behaviors</h4>




<div class="description">
    Set of behaviors to be used by the <a href="Editor.html">Editor</a>
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>grabber</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Grabber">Grabber</a></code></span>


            
            </td>

            

            

            <td class="description last">Grabber to capture strokes</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>strokerList</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;<a href="global.html#Stroker">Stroker</a>></code></span>


            
            </td>

            

            

            <td class="description last">List of stroker to draw stroke</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>rendererList</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;<a href="global.html#Renderer">Renderer</a>></code></span>


            
            </td>

            

            

            <td class="description last">List of renderer to draw on the editor</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>recognizerList</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;<a href="global.html#Recognizer">Recognizer</a>></code></span>


            
            </td>

            

            

            <td class="description last">Recognizers to call the recognition service</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>getBehaviorFromConfiguration</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Get the current behavior to use regarding the current configuration</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>events</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array</code></span>


            
            </td>

            

            

            <td class="description last">Functions to handle model changes</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultBehaviors.js.html">configuration/DefaultBehaviors.js</a>, <a href="configuration_DefaultBehaviors.js.html#line21">line 21</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="Bounds">Bounds</h4>




<div class="description">
    Bounding box
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>minX</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">Minimal x coordinate</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>maxX</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">Maximal x coordinate</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>minY</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">Minimal y coordinate</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>maxY</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">Maximal y coordinate</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line35">line 35</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-method">

    

    <h4 class="name" id="BuildWebSocketFunction"><span class="type-signature"></span>BuildWebSocketFunction<span class="signature">(destructuredPromise, recognizerContext)</span><span class="type-signature"> &rarr; {<a href="global.html#Callback">Callback</a>}</span></h4>

    



<div class="description">
    Build websocket function
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_websocket_WsRecognizerUtil.js.html">recognizer/websocket/WsRecognizerUtil.js</a>, <a href="recognizer_websocket_WsRecognizerUtil.js.html#line18">line 18</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>destructuredPromise</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#DestructuredPromise">DestructuredPromise</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>recognizerContext</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognizerContext">RecognizerContext</a></code></span>


            
            </td>

            

            

            <td class="description last">
                
                
            </td>
        </tr>

    
    </tbody>
</table>














<div class="section-returns">
<h5>Returns:</h5>

        

<dl class="param-type">
    <dt>
        Type:
    </dt>
    <dd>
        
<span class="param-type"><code><a href="global.html#Callback">Callback</a></code></span>


    </dd>
</dl>


    
</div>



</div>
            
                
<div class="section-method">

    

    <h4 class="name" id="Callback"><span class="type-signature"></span>Callback<span class="signature">(err<span class="signature-attributes">opt</span>, res<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Simple callback
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_DefaultRecognizer.js.html">recognizer/DefaultRecognizer.js</a>, <a href="recognizer_DefaultRecognizer.js.html#line31">line 31</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>err</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                Error
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>res</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                Result
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
            
                
<div class="section-members">
<h4 class="name" id="Constants">Constants</h4>








<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_Constants.js.html">configuration/Constants.js</a>, <a href="configuration_Constants.js.html#line1">line 1</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="DestructuredPromise">DestructuredPromise</h4>








    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>promise</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Promise</code></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>resolve</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>reject</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_PromiseHelper.js.html">util/PromiseHelper.js</a>, <a href="util_PromiseHelper.js.html#line1">line 1</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="GeneratedTheme">GeneratedTheme</h4>








    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>font-family</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                    STIXGeneral
                
                </td>
            

            <td class="description last">Font-family to be used</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                    #A8A8A8FF
                
                </td>
            

            <td class="description last">Color to be used</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultTheme.js.html">configuration/DefaultTheme.js</a>, <a href="configuration_DefaultTheme.js.html#line12">line 12</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="Grabber">Grabber</h4>




<div class="description">
    Grab pointerDown, pointerMove and pointerUp events
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>attach</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Attach events and decide when to call editor pointerDown/Move/Up methods</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>detach</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Detach the grabber</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="grabber_PointerEventGrabber.js.html">grabber/PointerEventGrabber.js</a>, <a href="grabber_PointerEventGrabber.js.html#line3">line 3</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="GrabberContext">GrabberContext</h4>




<div class="description">
    Grabber context
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Boolean</code></span>
|

<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">Options object that specifies characteristics about the event listener. (@see addEventListener.options for detail)</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>listeners</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;<a href="global.html#GrabberListener">GrabberListener</a>></code></span>


            
            </td>

            

            

            <td class="description last">Registered listeners</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="grabber_PointerEventGrabber.js.html">grabber/PointerEventGrabber.js</a>, <a href="grabber_PointerEventGrabber.js.html#line17">line 17</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="GrabberListener">GrabberListener</h4>




<div class="description">
    Grabber listener
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>types</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;String></code></span>


            
            </td>

            

            

            <td class="description last">Event types to listen</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>listener</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Event listener for these events</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="grabber_PointerEventGrabber.js.html">grabber/PointerEventGrabber.js</a>, <a href="grabber_PointerEventGrabber.js.html#line10">line 10</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="InkTheme">InkTheme</h4>








<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultTheme.js.html">configuration/DefaultTheme.js</a>, <a href="configuration_DefaultTheme.js.html#line5">line 5</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code><a href="global.html#PenStyle">PenStyle</a></code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="MathTheme">MathTheme</h4>








    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>font-family</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                    STIXGeneral
                
                </td>
            

            <td class="description last">Font-family to be used</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultTheme.js.html">configuration/DefaultTheme.js</a>, <a href="configuration_DefaultTheme.js.html#line8">line 8</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="Model">Model</h4>




<div class="description">
    Editor model
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>currentStroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Stroke">Stroke</a></code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Stroke in building process.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>rawStrokes</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;<a href="global.html#Stroke">Stroke</a>></code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last">List of captured strokes.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>strokeGroups</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array</code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last">Group of strokes with same pen style.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>lastPositions</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognitionPositions">RecognitionPositions</a></code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Last recognition sent/received stroke indexes.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>defaultSymbols</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;Object></code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last">Default symbols, relative to the current recognition type.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>recognizedSymbols</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;Object></code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Symbols to render (e.g. stroke, shape primitives, string, characters...).</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>exports</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Result of the export (e.g. mathml, latex, text...).</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>rawResults</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RawResults">RawResults</a></code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">The recognition output as return by the recognition service.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>creationTime</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Date of creation timestamp.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>modificationTime</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Date of lastModification.</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line20">line 20</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="PenStyle">PenStyle</h4>








    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                    #000000
                
                </td>
            

            <td class="description last">Color (supported formats rgb() rgba() hsl() hsla() #rgb #rgba #rrggbb #rrggbbaa)</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>-myscript-pen-width</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                    1
                
                </td>
            

            <td class="description last">Width of strokes and primitives in mm (no other unit is supported yet)</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>-myscript-pen-fill-style</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                    none
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>-myscript-pen-fill-color</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                    #FFFFFF00
                
                </td>
            

            <td class="description last">Color filled inside the area delimited by strokes and primitives</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultPenStyle.js.html">configuration/DefaultPenStyle.js</a>, <a href="configuration_DefaultPenStyle.js.html#line5">line 5</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="pointerEvents">pointerEvents</h4>




<div class="description">
    pointerEvents symbol
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                    pointerEvents
                
                </td>
            

            <td class="description last">Symbol type, 'pointerEvents' for pointerEvents</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>processGestures</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Boolean</code></span>


            
            </td>

            

            
                <td class="default">
                
                    False
                
                </td>
            

            <td class="description last">indicates if the gestures have to be processed</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>events</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;<a href="global.html#Stroke">Stroke</a>></code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last">the events to process</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_StrokeComponent.js.html">model/StrokeComponent.js</a>, <a href="model_StrokeComponent.js.html#line18">line 18</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="RawResults">RawResults</h4>




<div class="description">
    Raw results
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>convert</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">The convert result</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>exports</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">The exports output as return by the recognition service.</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line13">line 13</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="RecognitionContext">RecognitionContext</h4>




<div class="description">
    Recognition context
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Callback">Callback</a></code></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_RecognizerContext.js.html">model/RecognizerContext.js</a>, <a href="model_RecognizerContext.js.html#line3">line 3</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="RecognitionPositions">RecognitionPositions</h4>




<div class="description">
    Recognition positions
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>lastSentPosition</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            
                <td class="default">
                
                    -1
                
                </td>
            

            <td class="description last">Index of the last sent stroke.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>lastReceivedPosition</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            
                <td class="default">
                
                    -1
                
                </td>
            

            <td class="description last">Index of the last received stroke.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>lastRenderedPosition</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            
                <td class="default">
                
                    -1
                
                </td>
            

            <td class="description last">Last rendered recognized symbol position</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_InkModel.js.html">model/InkModel.js</a>, <a href="model_InkModel.js.html#line5">line 5</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="Recognizer">Recognizer</h4>




<div class="description">
    Recognition service entry point
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>getInfo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last">Get information about the supported configuration (protocol, type, apiVersion, ...).</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>init</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last">Initialize recognition.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>clear</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last">Clear server context. Currently nothing to do there.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>close</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last">Close and free all resources that will no longer be used by the recognizer.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>undo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Undo Undo the last done action.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>redo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Redo Redo the previously undone action.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>resize</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Resize.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>pointerEvents</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Pointer Events.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>addStrokes</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Add strokes.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>export_</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Export content.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>import_</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Import content.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>convert</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Convert.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>waitForIdle</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Wait for idle.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>setPenStyle</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Set pen style.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>setPenStyleClasses</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Set pen style classes.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>setTheme</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Set theme.</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_DefaultRecognizer.js.html">recognizer/DefaultRecognizer.js</a>, <a href="recognizer_DefaultRecognizer.js.html#line38">line 38</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-method">

    

    <h4 class="name" id="RecognizerCallback"><span class="type-signature"></span>RecognizerCallback<span class="signature">(err<span class="signature-attributes">opt</span>, model<span class="signature-attributes">opt</span>, &hellip;types<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Recognizer callback
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_DefaultRecognizer.js.html">recognizer/DefaultRecognizer.js</a>, <a href="recognizer_DefaultRecognizer.js.html#line23">line 23</a>
    </li></ul></dd>
    

    

    

    
</dl>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>err</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                Error
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>model</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Model">Model</a></code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">
                Result
                
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>types</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                    &lt;repeatable><br>
                
                </td>
            

            

            <td class="description last">
                Result types
                
            </td>
        </tr>

    
    </tbody>
</table>
















</div>
            
                
<div class="section-members">
<h4 class="name" id="RecognizerContext">RecognizerContext</h4>




<div class="description">
    Recognizer context
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Get a reference to the current editor</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>recognitionContexts</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;<a href="global.html#RecognitionContext">RecognitionContext</a>></code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>initPromise</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Promise</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>lastPositions</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#RecognitionPositions">RecognitionPositions</a></code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Last recognition sent/received stroke indexes.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>websocket</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>WebSocket</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>websocketCallback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>reconnect</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>currentReconnectionCount</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>sessionId</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>contentPartCount</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>currentPartId</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>instanceId</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>canUndo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Boolean</code></span>


            
            </td>

            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>canRedo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Boolean</code></span>


            
            </td>

            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>isEmpty</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Boolean</code></span>


            
            </td>

            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>supportedImportMimeTypes</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array</code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>undoStackIndex</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>possibleUndoCount</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>idle</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Boolean</code></span>


            
            </td>

            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>initialized</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Boolean</code></span>


            
            </td>

            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_RecognizerContext.js.html">model/RecognizerContext.js</a>, <a href="model_RecognizerContext.js.html#line10">line 10</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="RecognizerInfo">RecognizerInfo</h4>




<div class="description">
    Recognizer info
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>types</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;String></code></span>


            
            </td>

            

            

            <td class="description last">Supported recognition types (TEXT, MATH, SHAPE, MUSIC, ANALYZER).</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>protocol</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">Supported protocol (REST, WEBSOCKET).</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>apiVersion</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">Supported API version.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>availableTriggers</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#Triggers">Triggers</a></code></span>


            
            </td>

            

            

            <td class="description last">Supported triggers for this recognizer.</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_DefaultRecognizer.js.html">recognizer/DefaultRecognizer.js</a>, <a href="recognizer_DefaultRecognizer.js.html#line14">line 14</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="Renderer">Renderer</h4>




<div class="description">
    Default renderer
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>getInfo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Get some information about this renderer</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>attach</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Populate the DOM element to create rendering area.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>detach</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Remove rendering area from the DOM element.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>resize</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Explicitly resize the rendering area.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>drawCurrentStroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Draw the model currentStroke.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>drawModel</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Draw the model defaultSymbols and recognizedSymbols.</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_CanvasRenderer.js.html">renderer/canvas/CanvasRenderer.js</a>, <a href="renderer_canvas_CanvasRenderer.js.html#line14">line 14</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="RendererInfo">RendererInfo</h4>




<div class="description">
    Renderer info
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">Renderer type.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>apiVersion</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">Supported api version.</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_CanvasRenderer.js.html">renderer/canvas/CanvasRenderer.js</a>, <a href="renderer_canvas_CanvasRenderer.js.html#line7">line 7</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="SmartGuide">SmartGuide</h4>




<div class="description">
    Smart guide
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>editor</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="Editor.html">Editor</a></code></span>


            
            </td>

            

            

            <td class="description last">A reference to the current editor.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>wordToChange</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">Word to change following a click on a word.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>lastWord</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">Keep the last word of the previous export to compare with the new and scroll if it's different.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>previousLabelExport</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">Keep the previous label export to know if we should repopulate the prompter text.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>perfectScrollbar</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>PerfectScrollbar</code></span>


            
            </td>

            

            

            <td class="description last">Perfect Scrollbar used to get gestures from smart guide using touch-action none anyway and get scrolling too.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>elements</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Object</code></span>


            
            </td>

            

            

            <td class="description last">All the HTML elements of the smart guide.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>smartGuideTimeOutId</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            

            <td class="description last">Id of the setTimeOut from fade out animation to clear.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>randomString</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">Random string used in case of multiple smart guide.</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="smartguide_SmartGuide.js.html">smartguide/SmartGuide.js</a>, <a href="smartguide_SmartGuide.js.html#line5">line 5</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="Stroke">Stroke</h4>




<div class="description">
    Stroke symbol
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                    stroke
                
                </td>
            

            <td class="description last">Symbol type, 'stroke' for stroke</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>pointerType</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Pointer type</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>pointerId</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Pointer id</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;Number></code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last">X coordinates</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;Number></code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last">Y coordinates</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>t</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;Number></code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last">Timestamps matching x,y coordinates</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>p</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;Number></code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last">Pressure</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>l</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;Number></code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last">Length from origin</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">(for rendering) Pen/brush width</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">(for rendering) Pen/brush color</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_StrokeComponent.js.html">model/StrokeComponent.js</a>, <a href="model_StrokeComponent.js.html#line3">line 3</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="Stroker">Stroker</h4>




<div class="description">
    Define how a stroke should be drawn
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>getInfo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Get some information about this stroker</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>drawStroke</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Render a stroke on the current context.</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_stroker_QuadraticCanvasStroker.js.html">renderer/canvas/stroker/QuadraticCanvasStroker.js</a>, <a href="renderer_canvas_stroker_QuadraticCanvasStroker.js.html#line12">line 12</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="StrokerInfo">StrokerInfo</h4>




<div class="description">
    Stroker info
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">Renderer type.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">Stroker name.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>apiVersion</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            

            <td class="description last">Supported api version.</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="renderer_canvas_stroker_QuadraticCanvasStroker.js.html">renderer/canvas/stroker/QuadraticCanvasStroker.js</a>, <a href="renderer_canvas_stroker_QuadraticCanvasStroker.js.html#line4">line 4</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="TextTheme">TextTheme</h4>








    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>font-family</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>String</code></span>


            
            </td>

            

            
                <td class="default">
                
                    OpenSans
                
                </td>
            

            <td class="description last">Font-family to be used</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>font-size</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                    10
                
                </td>
            

            <td class="description last">Font-size to be used</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultTheme.js.html">configuration/DefaultTheme.js</a>, <a href="configuration_DefaultTheme.js.html#line17">line 17</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="Theme">Theme</h4>








    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ink</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#InkTheme">InkTheme</a></code></span>


            
            </td>

            

            

            <td class="description last">General settings</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>.math</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#MathTheme">MathTheme</a></code></span>


            
            </td>

            

            

            <td class="description last">Math theme</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>.math-solver</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#GeneratedTheme">GeneratedTheme</a></code></span>


            
            </td>

            

            

            <td class="description last">Theme to be used for generated items</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>.text</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code><a href="global.html#TextTheme">TextTheme</a></code></span>


            
            </td>

            

            

            <td class="description last">Text theme</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="configuration_DefaultTheme.js.html">configuration/DefaultTheme.js</a>, <a href="configuration_DefaultTheme.js.html#line22">line 22</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="Triggers">Triggers</h4>




<div class="description">
    Triggers
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>exportContent</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;String></code></span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last">Supported triggers for exporting content.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>addStrokes</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;String></code></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Supported triggers for adding strokes.</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="recognizer_DefaultRecognizer.js.html">recognizer/DefaultRecognizer.js</a>, <a href="recognizer_DefaultRecognizer.js.html#line7">line 7</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="UndoRedoContext">UndoRedoContext</h4>




<div class="description">
    Undo/redo context
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>stack</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Array.&lt;<a href="global.html#Model">Model</a>></code></span>


            
            </td>

            

            
                <td class="default">
                
                    [
                
                </td>
            

            <td class="description last">List of processed models.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>currentPosition</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                    -1
                
                </td>
            

            <td class="description last">Current model index into the stack.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>maxSize</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Number</code></span>


            
            </td>

            

            
                <td class="default">
                
                </td>
            

            <td class="description last">Max size of the stack.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>canUndo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Boolean</code></span>


            
            </td>

            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>canRedo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>Boolean</code></span>


            
            </td>

            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"></td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_UndoRedoContext.js.html">model/UndoRedoContext.js</a>, <a href="model_UndoRedoContext.js.html#line1">line 1</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
                
<div class="section-members">
<h4 class="name" id="UndoRedoManager">UndoRedoManager</h4>




<div class="description">
    Undo/redo manager
</div>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>updateModel</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Push the current model into the undo/redo context.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>undo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Undo.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>redo</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Redo.</td>
        </tr>

        

    

        <tr>
            
                <td class="name"><code>clear</code></td>
            

            <td class="type">
            
                
<span class="param-type"><code>function</code></span>


            
            </td>

            

            

            <td class="description last">Clear.</td>
        </tr>

        

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="model_UndoRedoManager.js.html">model/UndoRedoManager.js</a>, <a href="model_UndoRedoManager.js.html#line6">line 6</a>
    </li></ul></dd>
    

    

    

    
</dl>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><code>Object</code></span>


        </li>
    </ul>





</div>

            
    

    
</article>

</section>




</div>

<br class="clear">

<footer>
    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Wed Nov 04 2020 13:49:48 GMT+0100 (Central European Standard Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>